<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jetson Inference: jetson-utils/Mutex.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NVLogo_2D.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Jetson Inference
   </div>
   <div id="projectbrief">DNN Vision Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('Mutex_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">Mutex.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="Mutex_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2018, NVIDIA CORPORATION. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * copy of this software and associated documentation files (the &quot;Software&quot;),</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * to deal in the Software without restriction, including without limitation</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#ifndef __MULTITHREAD_MUTEX_H_</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#define __MULTITHREAD_MUTEX_H_</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;pthread.h&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classMutex.html">   35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classMutex.html">Mutex</a></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;        <a class="code" href="classMutex.html#a593423d868daf926c7b0d63a833ae29a">Mutex</a>();</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        <a class="code" href="classMutex.html#ac9e9182407f5f74892318607888e9be4">~Mutex</a>();</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classMutex.html#a87f92bea41231778680c392668b4ad6f">   52</a></span>&#160;        <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classMutex.html#a87f92bea41231778680c392668b4ad6f">AttemptLock</a>()                                       { <span class="keywordflow">return</span> (pthread_mutex_trylock(&amp;<a class="code" href="classMutex.html#a8fc19c03aa404e9efddc2c91132ebd02">mID</a>) == 0); }</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classMutex.html#ae5cb54c9c45f90e29206d5679a3b1c7f">   58</a></span>&#160;        <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classMutex.html#ae5cb54c9c45f90e29206d5679a3b1c7f">Lock</a>()                                                      { pthread_mutex_lock(&amp;<a class="code" href="classMutex.html#a8fc19c03aa404e9efddc2c91132ebd02">mID</a>); }</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classMutex.html#ad5de61abafec4bbec4cd7e796e5209fd">   63</a></span>&#160;        <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classMutex.html#ad5de61abafec4bbec4cd7e796e5209fd">Unlock</a>()                                            { pthread_mutex_unlock(&amp;<a class="code" href="classMutex.html#a8fc19c03aa404e9efddc2c91132ebd02">mID</a>); }         </div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classMutex.html#a5fce312e70fb4d09af9436d4e5912f7e">   69</a></span>&#160;        <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classMutex.html#a5fce312e70fb4d09af9436d4e5912f7e">Sync</a>()                                                      { <a class="code" href="classMutex.html#ae5cb54c9c45f90e29206d5679a3b1c7f">Lock</a>(); <a class="code" href="classMutex.html#ad5de61abafec4bbec4cd7e796e5209fd">Unlock</a>(); }</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classMutex.html#a7d62eeb42273e4f4946ebf8a757db4c9">   74</a></span>&#160;        pthread_mutex_t* <a class="code" href="classMutex.html#a7d62eeb42273e4f4946ebf8a757db4c9">GetID</a>()                                        { <span class="keywordflow">return</span> &amp;<a class="code" href="classMutex.html#a8fc19c03aa404e9efddc2c91132ebd02">mID</a>; }</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classMutex.html#a8fc19c03aa404e9efddc2c91132ebd02">   77</a></span>&#160;        pthread_mutex_t <a class="code" href="classMutex.html#a8fc19c03aa404e9efddc2c91132ebd02">mID</a>;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;};</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classMutex_html_a8fc19c03aa404e9efddc2c91132ebd02"><div class="ttname"><a href="classMutex.html#a8fc19c03aa404e9efddc2c91132ebd02">Mutex::mID</a></div><div class="ttdeci">pthread_mutex_t mID</div><div class="ttdef"><b>Definition:</b> Mutex.h:77</div></div>
<div class="ttc" id="classMutex_html_a593423d868daf926c7b0d63a833ae29a"><div class="ttname"><a href="classMutex.html#a593423d868daf926c7b0d63a833ae29a">Mutex::Mutex</a></div><div class="ttdeci">Mutex()</div><div class="ttdoc">Constructor. </div></div>
<div class="ttc" id="classMutex_html_a87f92bea41231778680c392668b4ad6f"><div class="ttname"><a href="classMutex.html#a87f92bea41231778680c392668b4ad6f">Mutex::AttemptLock</a></div><div class="ttdeci">bool AttemptLock()</div><div class="ttdoc">If the lock is free, aquire it. </div><div class="ttdef"><b>Definition:</b> Mutex.h:52</div></div>
<div class="ttc" id="classMutex_html"><div class="ttname"><a href="classMutex.html">Mutex</a></div><div class="ttdoc">A lightweight mutual exclusion lock. </div><div class="ttdef"><b>Definition:</b> Mutex.h:35</div></div>
<div class="ttc" id="classMutex_html_ae5cb54c9c45f90e29206d5679a3b1c7f"><div class="ttname"><a href="classMutex.html#ae5cb54c9c45f90e29206d5679a3b1c7f">Mutex::Lock</a></div><div class="ttdeci">void Lock()</div><div class="ttdoc">Aquire the lock, whenever it becomes available. </div><div class="ttdef"><b>Definition:</b> Mutex.h:58</div></div>
<div class="ttc" id="classMutex_html_ac9e9182407f5f74892318607888e9be4"><div class="ttname"><a href="classMutex.html#ac9e9182407f5f74892318607888e9be4">Mutex::~Mutex</a></div><div class="ttdeci">~Mutex()</div><div class="ttdoc">Destructor. </div></div>
<div class="ttc" id="classMutex_html_a7d62eeb42273e4f4946ebf8a757db4c9"><div class="ttname"><a href="classMutex.html#a7d62eeb42273e4f4946ebf8a757db4c9">Mutex::GetID</a></div><div class="ttdeci">pthread_mutex_t * GetID()</div><div class="ttdoc">Get the mutex object. </div><div class="ttdef"><b>Definition:</b> Mutex.h:74</div></div>
<div class="ttc" id="classMutex_html_ad5de61abafec4bbec4cd7e796e5209fd"><div class="ttname"><a href="classMutex.html#ad5de61abafec4bbec4cd7e796e5209fd">Mutex::Unlock</a></div><div class="ttdeci">void Unlock()</div><div class="ttdoc">Release the lock. </div><div class="ttdef"><b>Definition:</b> Mutex.h:63</div></div>
<div class="ttc" id="classMutex_html_a5fce312e70fb4d09af9436d4e5912f7e"><div class="ttname"><a href="classMutex.html#a5fce312e70fb4d09af9436d4e5912f7e">Mutex::Sync</a></div><div class="ttdeci">void Sync()</div><div class="ttdoc">Wait for the lock, then release it immediately. </div><div class="ttdef"><b>Definition:</b> Mutex.h:69</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_54a0acf6da04fe2ed9410b4c6369bc5d.html">jetson-utils</a></li><li class="navelem"><a class="el" href="Mutex_8h.html">Mutex.h</a></li>
    <li class="footer">Generated on Fri Jun 21 2019 16:23:15 for Jetson Inference by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
